<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Optimist Racing: C:/Users/Owner/My Programming/Personal Projects/VideoGames/Optimist Racing/src/Keyboard.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="logo-small.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">Optimist Racing
   &#160;<span id="projectnumber">0.1</span>
   </div>
   <div id="projectbrief">A video game where you must literally keep your head up</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('_keyboard_8hpp_source.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">Keyboard.hpp</div>  </div>
</div><!--header-->
<div class="contents">
<a href="_keyboard_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*  Copyright (C) 2012  Claude Richard</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> *  This program is free software: you can redistribute it and/or modify</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> *  it under the terms of the GNU General Public License as published by</span></div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> *  the Free Software Foundation, either version 3 of the License, or</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> *  (at your option) any later version.</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> *  This program is distributed in the hope that it will be useful,</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> *  but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span></div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> *  GNU General Public License for more details.</span></div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> *  You should have received a copy of the GNU General Public License</span></div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> *  along with this program.  If not, see &lt;http://www.gnu.org/licenses/&gt;.</span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;</div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00019"></a><span class="lineno"><a class="code" href="_keyboard_8hpp.html#ad4a278e59ed8d2af129f9b88eaa342ae">   19</a></span>&#160;<span class="keyword">enum</span> <a class="code" href="_keyboard_8hpp.html#ad4a278e59ed8d2af129f9b88eaa342ae">E_BUTTON</a> {</div>
<div class="line"><a name="l00020"></a><span class="lineno"><a class="code" href="_keyboard_8hpp.html#ad4a278e59ed8d2af129f9b88eaa342aea64fb6ad7eaa79e73a6a433311cd7ed08">   20</a></span>&#160;    <a class="code" href="_keyboard_8hpp.html#ad4a278e59ed8d2af129f9b88eaa342aea64fb6ad7eaa79e73a6a433311cd7ed08">BUTTON_NOTHING</a>,</div>
<div class="line"><a name="l00021"></a><span class="lineno"><a class="code" href="_keyboard_8hpp.html#ad4a278e59ed8d2af129f9b88eaa342aeae10fa07e68d34ce7acc6a5b2717104a9">   21</a></span>&#160;    <a class="code" href="_keyboard_8hpp.html#ad4a278e59ed8d2af129f9b88eaa342aeae10fa07e68d34ce7acc6a5b2717104a9">BUTTON_TURN_LEFT</a>,</div>
<div class="line"><a name="l00022"></a><span class="lineno"><a class="code" href="_keyboard_8hpp.html#ad4a278e59ed8d2af129f9b88eaa342aeac60a13a15de7ac1d3223d17b8715fc2b">   22</a></span>&#160;    <a class="code" href="_keyboard_8hpp.html#ad4a278e59ed8d2af129f9b88eaa342aeac60a13a15de7ac1d3223d17b8715fc2b">BUTTON_TURN_RIGHT</a>,</div>
<div class="line"><a name="l00023"></a><span class="lineno"><a class="code" href="_keyboard_8hpp.html#ad4a278e59ed8d2af129f9b88eaa342aea37666936297216dce293b0aa31c474b8">   23</a></span>&#160;    <a class="code" href="_keyboard_8hpp.html#ad4a278e59ed8d2af129f9b88eaa342aea37666936297216dce293b0aa31c474b8">BUTTON_UP</a>,</div>
<div class="line"><a name="l00024"></a><span class="lineno"><a class="code" href="_keyboard_8hpp.html#ad4a278e59ed8d2af129f9b88eaa342aea0c7746cfbcac16484b2266e6f51e5e0b">   24</a></span>&#160;    <a class="code" href="_keyboard_8hpp.html#ad4a278e59ed8d2af129f9b88eaa342aea0c7746cfbcac16484b2266e6f51e5e0b">BUTTON_DOWN</a>,</div>
<div class="line"><a name="l00025"></a><span class="lineno"><a class="code" href="_keyboard_8hpp.html#ad4a278e59ed8d2af129f9b88eaa342aea49ee35c120c2ab8e7864ecb11a6f8125">   25</a></span>&#160;    <a class="code" href="_keyboard_8hpp.html#ad4a278e59ed8d2af129f9b88eaa342aea49ee35c120c2ab8e7864ecb11a6f8125">BUTTON_SKID_LEFT</a>,</div>
<div class="line"><a name="l00026"></a><span class="lineno"><a class="code" href="_keyboard_8hpp.html#ad4a278e59ed8d2af129f9b88eaa342aea3b4428e4ef3db9c1204b18cc1d894757">   26</a></span>&#160;    <a class="code" href="_keyboard_8hpp.html#ad4a278e59ed8d2af129f9b88eaa342aea3b4428e4ef3db9c1204b18cc1d894757">BUTTON_SKID_RIGHT</a>,</div>
<div class="line"><a name="l00027"></a><span class="lineno"><a class="code" href="_keyboard_8hpp.html#ad4a278e59ed8d2af129f9b88eaa342aea74c236b5fee1b426bf74fbcb70ffbf16">   27</a></span>&#160;    <a class="code" href="_keyboard_8hpp.html#ad4a278e59ed8d2af129f9b88eaa342aea74c236b5fee1b426bf74fbcb70ffbf16">BUTTON_NUM</a></div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;};</div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;</div>
<div class="line"><a name="l00030"></a><span class="lineno"><a class="code" href="classcm_key_manager.html">   30</a></span>&#160;<span class="keyword">class </span><a class="code" href="classcm_key_manager.html">cmKeyManager</a> {</div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;</div>
<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;</div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;    <span class="comment">// The constructor and destructor are pretty standard.</span></div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;    <span class="comment">// The key mapping is set to something not very usable.</span></div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;    <a class="code" href="classcm_key_manager.html#a79ae9754c7fe3ea67f6c8184adf90691">cmKeyManager</a>();</div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;    <a class="code" href="classcm_key_manager.html#a0c96493d3fd7fa83e74dae732cc18df3">~cmKeyManager</a>();</div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;</div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;    <span class="comment">// TODO: load and save map from keyboard to button.</span></div>
<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;<span class="comment"></span>    <span class="comment">//void load_mappings( const char* filename );</span></div>
<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;<span class="comment"></span>    <span class="comment">//void save_mappings( const char* filename ) const;</span></div>
<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;</div>
<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;</div>
<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;    <span class="comment">// Links a key to a keytype.</span></div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classcm_key_manager.html#abb23711c55b58fed5a85d4ab59b1a8ff">set_mapping</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> key, <a class="code" href="_keyboard_8hpp.html#ad4a278e59ed8d2af129f9b88eaa342ae">E_BUTTON</a> keytype );</div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classcm_key_manager.html#aa70f8c04d16bcd19f99dd0117d3b5cd0">set_special_mapping</a>( <span class="keywordtype">int</span> key, <a class="code" href="_keyboard_8hpp.html#ad4a278e59ed8d2af129f9b88eaa342ae">E_BUTTON</a> keytype );</div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;</div>
<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;    <span class="comment">// Call this during the key-press event.</span></div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classcm_key_manager.html#a62fe4906c92806bafc66f37a5dcd63f1">press_key</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> key );</div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classcm_key_manager.html#ae8f67f69903df93356cf0a36be42f8c2">press_special_key</a>( <span class="keywordtype">int</span> key );</div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;    <span class="comment">// Call this during the key-release event.</span></div>
<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classcm_key_manager.html#a3c3daabf86791170d0db86491dda289c">release_key</a>( <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> key );</div>
<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classcm_key_manager.html#ae8f80f4a5ff0a6e11ad0a06fc855a960">release_special_key</a>( <span class="keywordtype">int</span> key );</div>
<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;</div>
<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;    <span class="comment">// This resets m_times_pressed and m_times_released</span></div>
<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;    <span class="comment">// Call this after a frame has passed.</span></div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;    <span class="keywordtype">void</span> <a class="code" href="classcm_key_manager.html#a4a346eef64306328b72f5ce245bf8788">reset_counts</a>();</div>
<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;</div>
<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;    <span class="comment">// Get methods for keys (cman_keys)</span></div>
<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;    <span class="keywordtype">int</span> <a class="code" href="classcm_key_manager.html#a5fa0ab83e8f36c9a721794c17fb13cb1">times_pressed</a>( <a class="code" href="_keyboard_8hpp.html#ad4a278e59ed8d2af129f9b88eaa342ae">E_BUTTON</a> button ) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;    <span class="keywordtype">int</span> <a class="code" href="classcm_key_manager.html#af5d00cb2ad3b1c6350b5486cb2ec27ee">times_released</a>( <a class="code" href="_keyboard_8hpp.html#ad4a278e59ed8d2af129f9b88eaa342ae">E_BUTTON</a> button ) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;    <span class="keywordtype">bool</span> <a class="code" href="classcm_key_manager.html#af97cb352de7f7e88efb2beb56a2c68d2">is_pressed</a>( <a class="code" href="_keyboard_8hpp.html#ad4a278e59ed8d2af129f9b88eaa342ae">E_BUTTON</a> button ) <span class="keyword">const</span>;</div>
<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;</div>
<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;</div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;    <span class="comment">// These are arrays. Each array has one element per button</span></div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;    <span class="comment">// Each key has a number of times pressed since the last reset.</span></div>
<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;    <span class="comment">// Each key has a number of times released since the last reset.</span></div>
<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;    <span class="keywordtype">int</span>* m_times_pressed;</div>
<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;    <span class="keywordtype">int</span>* m_times_released;</div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;    <span class="keywordtype">bool</span>* m_pressed;</div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;</div>
<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;    <span class="comment">// This is the current key mapping from keyboard to cman-buttons.</span></div>
<div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;    <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *m_key_map;</div>
<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;    <span class="keywordtype">int</span> *m_special_key_map;</div>
<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;</div>
<div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;};</div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="_keyboard_8hpp.html">Keyboard.hpp</a></li>
    <li class="footer">Generated on Sun Oct 28 2012 13:14:14 for Optimist Racing by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.2 </li>
  </ul>
</div>
</body>
</html>
